fix(docs-sync): stop overwriting the generated root _meta.json#352
Merged
Conversation
The sync-docs workflow rsynced the generated category-based docs/api-references/_meta.json into genlayer-docs and then immediately overwrote it with a hardcoded heredoc containing the pre-grouping flat command list (init, up, deploy, ...). Those keys no longer match the directory layout, so the genlayer-docs sidebar rendered broken entries on every sync (fixed manually in genlayer-docs#426; this removes the cause). Also make the generated root meta complete: - add "index": "Overview" for the generated index.mdx - append ungrouped top-level commands (estimate-fees, finalize, finalize-batch) so they get explicit nav entries instead of relying on Nextra's implicit append Snapshot under docs/api-references regenerated against current main (picks up the new estimate-fees command and latest help text). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
This PR targeted I retargeted it to |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR documents three new CLI commands ( ChangesCLI Documentation for Fee and Finalize Commands
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ae7fd726f6
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | | --rpc <rpcUrl> | RPC URL for the network | No | | | ||
| | | --fees <json> | Fee estimate options JSON passed to genlayer-js estimateTransactionFees. | No | | | ||
| | | --json | Print the fee estimate as JSON without spinner output | No | | | ||
| | | --include-report | Include simulation fee accounting/report in the generated estimate output | No | | |
There was a problem hiding this comment.
When users run estimate-fees in simulation mode for a contract method that takes arguments, the CLI accepts --args <args...> (src/commands/contracts/index.ts:163-168), but this newly added options table omits that option and only documents --rpc, --fees, --json, and --include-report. This leaves the generated reference incomplete for the main case where [contractAddress] [method] needs calldata arguments.
Useful? React with 👍 / 👎.
…ta-overwrite # Conflicts: # docs/api-references/contracts/deploy.mdx # docs/api-references/contracts/write.mdx # docs/api-references/estimate-fees.mdx
Member
|
/run-e2e tooling |
MuncleUscles
added a commit
that referenced
this pull request
Jul 8, 2026
* fix(system): propagate command-check and version parse fixes to v0.40-dev (#350) Propagates #349 to v0.40-dev. * docs: add branching guide (#353) * docs: add branching guide * ci: harden testnet smoke timeout * feat: support fee profiles in contract commands (#355) * feat: support fee profiles in contract commands * test: make fee profile deploy test portable * feat: staking validators discovery (#357) * feat: add staking validators discovery * feat: epoch-aware validator listing with below-min indicator * fix(staking): account-less client for read-only staking queries getReadOnlyStakingClient threw 'Account not found' on fresh installs; listings and other reads don't need a local account. * feat: vesting commands (#358) * feat: add vesting commands * feat(vesting): validator subcommands — create/join, deposit, exit, claim, operator-transfer, set-identity, list/status Drives the CON-607 Vesting.sol validator leg through the SDK's named vestingValidator* actions; list/status enumerate getValidatorWallets with per-wallet deposited principal. * chore(deps): update dependency uuid to v11.1.1 [security] (#320) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(init): use backend provider id "google" for Gemini (#359) Selecting Gemini during `genlayer init` failed with: Requested providers '{'geminiai'}' do not match any stored providers. The selected provider id is forwarded verbatim to sim_createRandomValidators, but the backend's llm_provider table stores Gemini as "google". Rename the provider id geminiai -> google so it matches. Display name ("Gemini") and env var (GEMINI_API_KEY) are unchanged. Since "geminiai" never resolved to a valid provider, no working configuration relied on it. Fixes #271 Co-authored-by: Edgars Nemše <edgars@genlayerlabs.com> * fix(docs-sync): stop overwriting the generated root _meta.json (#352) The sync-docs workflow rsynced the generated category-based docs/api-references/_meta.json into genlayer-docs and then immediately overwrote it with a hardcoded heredoc containing the pre-grouping flat command list (init, up, deploy, ...). Those keys no longer match the directory layout, so the genlayer-docs sidebar rendered broken entries on every sync (fixed manually in genlayer-docs#426; this removes the cause). Also make the generated root meta complete: - add "index": "Overview" for the generated index.mdx - append ungrouped top-level commands (estimate-fees, finalize, finalize-batch) so they get explicit nav entries instead of relying on Nextra's implicit append Snapshot under docs/api-references regenerated against current main (picks up the new estimate-fees command and latest help text). Co-authored-by: Albert Castellana <albert@genlayer.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Edgars <edgars@entropicsolutions.io> * fix: drop getSlashingAddress from validator-history (#361) getSlashingAddress() was removed from the genlayer-js SDK (v0.39+/v2-dev), causing `genlayer staking validator-history` to crash with `client.getSlashingAddress is not a function` before any history is fetched. Resolve the idleness (slashing) contract address dynamically via viem readContract against consensusMainContract.getIdlenessAddress(), falling back to the staking contract address if resolution fails so reward events still display. Port of #344 (by @ygd58) from the dead v0.39 line to v0.40-dev. Supersedes #344. Fixes #341 Co-authored-by: Edgars <edgars@entropicsolutions.io> * feat(network): custom network profiles with deployment-file import (#362) * feat(network): custom network profiles with deployment-file import genlayer network add <alias> --base <built-in> [--deployment <json>] [--rpc <url>] [--consensus-main|--consensus-data|--staking|--fee-manager |--rounds-storage|--appeals <addr>] [--chain-id <n>] [--deployment-key <path>] Profiles persist as base + address overrides only; resolveNetwork loads the base chain fresh from genlayer-js and applies overrides, so ABIs never go stale. network set/list/info/remove and StakingAction --network accept custom aliases. The consensus deployments.json shape is parsed by walking the tree for ContractName->address leaves (ConsensusMain, ConsensusData, GenStaking/Staking, FeeManager, Rounds/RoundsStorage, Appeals); flags take precedence over the file. Adds a prepare script so npm install from a git ref builds dist. Verified: 576 vitest tests, full manual smoke (add/list/set/info/remove with a deployment file). * chore(deps): bump genlayer-js to v2-dev tip for vesting actions The locked v2-dev SHA (28e99fbc) predates the vesting client actions; vestingValidatorJoin and friends land at 666d1156. Verified live: vesting validator create succeeds against a #1162-branch consensus deployment. * docs(cli): regenerate API references; fix option placeholder regex The docs generator's option regex only matched <word> placeholders, so flags with dots or hyphens in the value name (--base <built-in-alias>, --deployment <path.json>, --deployment-key <dot.path>) were silently dropped from the options tables. Widen to <[^>]+> and regenerate: adds the network add/remove pages and the previously undocumented vesting command section (validator create/deposit/exit/claim, operator-transfer, set-identity, delegate/undelegate/claim/withdraw/list). * fix(vesting): resolve validator wallet address in create output The join receipt does not carry the new wallet address, so the output printed validatorWallet: undefined. Read getValidatorWallets from the vesting contract after the join and report the newest entry. Verified live against a #1162-branch deployment. * fix: make git install build lifecycle robust (#363) * fix: make git install build script self contained * chore: refresh genlayer-js lockfile * fix: make keychain dependency optional * fix: restore git prepare build * fix: include build dependency for git installs * chore: keep esbuild as dev dependency * ci: publish prereleases to npm dist tags (#364) * ci: add clarke cli tarball release * ci: publish prereleases to npm dist tags * Release v0.40.0-rc1 [skip ci] --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Tobu <36818942+Tobu8888@users.noreply.github.com> Co-authored-by: Albert Castellana <acastellana@users.noreply.github.com> Co-authored-by: Albert Castellana <albert@genlayer.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Edgars <edgars@entropicsolutions.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
sync-docs.ymlrsyncs the generated, category-baseddocs/api-references/_meta.jsoninto genlayer-docs — and then immediately overwrites it with a hardcoded heredoc containing the pre-grouping flat command list (init,up,deploy, …). Those keys haven't matched the directory layout since the commands were grouped into category folders, so every sync shipped a broken sidebar to docs.genlayer.com (most entries pointed at nothing, and whole command groups were missing from the LLM exports there).genlayerlabs/genlayer-docs#426 fixed the meta manually on the docs side; this PR removes the cause so the next release sync doesn't regress it.
Changes
.github/workflows/sync-docs.yml: delete the heredoc — the rsynced generated_meta.jsonis correct.scripts/generate-cli-docs.mjs: make the generated root meta complete —"index": "Overview"first, then the category groups, then any ungrouped top-level commands (currentlyestimate-fees,finalize,finalize-batch) so they get explicit nav entries.docs/api-references/snapshot: regenerated against current main (node scripts/generate-cli-docs.mjsafternpm run build) — picks up the newestimate-feescommand page and latest help text.Verification
Ran the generator locally against a fresh build; the emitted root
_meta.jsonis:{ "index": "Overview", "environment": "Environment", "configuration": "Configuration", "contracts": "Contracts", "transactions": "Transactions", "accounts": "Accounts", "staking": "Staking", "localnet": "Localnet", "estimate-fees": "estimate-fees", "finalize": "finalize", "finalize-batch": "finalize-batch" }which matches the directory layout the workflow rsyncs (67 pages generated).
🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
estimate-fees,finalize, andfinalize-batch--fees,--fee-value,--valid-until) to deploy and write commandsDocumentation